Commands Syntax

This document presents the composition of a command and introduces the various vocabulary terms that will be used later.

A command can be broken down into five elements:

On Windows / UNIX / OpenVMS, the syntax is as follows:

Command Object Environment Items Input-Output

On OS/400 the program associated to the command can be called with the following syntax:

CALL PGM(<PROGRAM>) PARM(Object Environment Items Input-Output)

Description of Items

• Command / PROGRAM

  Command verb to be used. The command verb should always be entered first. If the current job directory is not the UNI_DIR_EXEC directory, the latter should be specified in the command (except on OpenVMS). On OS/400, the Company library must be loaded.

  Example: in UNIX, the uxlst command displays the list of objects type:

  ${UNI_DIR_EXEC}/uxlst UPR

• Object

  Keyword indicating the object or function to be targeted. The object must be inserted immediately after the command verb; qualifying items can then be used in any order.

  In the example below, the keyword is UPR. It specifies that the command concerns Uprocs type objects.

  ${UNI_DIR_EXEC}/uxlst UPR

• Environment

  Working environment: node, area, and sometimes management unit.

  The execution of the unienv file (in the Company's root directory) must be executed to load the default environment. The items below can be set to overwrite the default values.

  • NODE=

    Enter Dollar Universe node name. All the commands only concern the nodes of the same Company.

    If the command targets a remote node, it must be declared on the same UVMS as the Dollar Universe local node or, for “Master / Subordinate UVMS” architecture, on a UVMS subordinate (with the same master) that shares its nodes.

    On Windows / UNIX / OpenVMS: if no node is specified, the value of the variable S_NODENAME (up to 64 characters) will be used by default.

    On OS/400 in display mode, if the node is not specified, the current node (*CURRENT) is used.
    

  • EXP | SIM | INT |APP

    Valid for parameter and operation commands

    Area in which the command must execute. Enter:

    • EXP for production area,
    • SIM for simulation area,
    • INT for integration area,
    • APP for application area.

    Default:

    • On Windows / UNIX / OpenVMS: S_ESPEXE variable value.
    • On OS/400: *CURRENT is used.

  • ESP=

    Valid for batch management and DQM commands.

    Area in which the command must execute. Enter:

    • X for production area,
    • S for simulation area,
    • I for integration area,
    • A for application area.

    Défaut : S_ESPEXE variable value.

• Items

  Working records defining the required information. On OS/400 all the items must be entered in quotes, f or example: ‘MU=MYMU’.

  For each command a list of items is detailed:

  • Optional items are shown in brackets [ ].

  • Underlined value indicates the default value.

  • "*" (wildcards) means that a generic value is acceptable.

• Input-Output

  Identification of files containing concatenated input data necessary to the function (INPUT=filename) or the output file where collected data should be deposited (OUTPUT=filename).

  The INPUT and OUTPUT items are used mainly with Dollar Universe extraction and insertion commands uxext and uxins to facilitate interfacing with a remote distribution product for example.

  The output item can also be used by the uxshw or uxlst commands to divert output data from a screen (default) to a disk file.

  The same output file can be used for several uxext commands (applying to different types of object), the extracted data being appended to the end of the file created by the previous commands.

  It is recommended however not to use the same output file for objects belonging to different areas as the use of generic addressing on versions of objects (Uprocs, sessions and tasks) could well cause confusion. For example, if the same output file contains the results of the following two commands:

  uxext UPR APP UPR="*" VUPR="*" OUTPUT=filename

  uxext UPR INT UPR="*" VUPR="*" OUTPUT=filename

  In the case where Uprocs with the same version exist in both areas and if the item REPL is not specified, the Uproc / version from the application area will prevail.

  If the item REPL is specified, then the Uproc / version from the integration area will overwrite the existing record from the application area.

Return Code

Codes returned by the commands are the following:

• 0 (or odd number on OpenVMS): The command has been executed correctly.

• 1 (or even number on OpenVMS): The command could not be executed correctly; a message explains the reason of the failure: syntax error, I/O server absent etc.

• 255 or -1: The command has been executed correctly but had nothing to do (for example: no events to delete).